ENG-10376 docs: add enterprise auth audit hook page - #6818
Conversation
Documents AuthPlugin(audit=...) — the observe-only audit hook shipping in reflex-enterprise 0.9.3 (reflex-dev/reflex-enterprise#200): configuration, action/outcome taxonomy, the AuditContext reference, and the fail-open, volume, privacy, and popup-flow semantics. Registers the page in the enterprise sidebar and the overview's Authentication block.
Greptile SummaryAdds documentation and navigation for the enterprise authentication audit hook.
Confidence Score: 5/5The PR appears safe to merge. No blocking failure remains.
|
| Filename | Overview |
|---|---|
| docs/enterprise/auth/audit.md | Adds the comprehensive enterprise authentication audit-hook documentation and examples. |
| docs/app/reflex_docs/templates/docpage/sidebar/sidebar_items/enterprise.py | Registers the new audit documentation page in the enterprise authentication sidebar. |
| docs/enterprise/overview.md | Adds the audit hook to the enterprise feature catalog and updates its feature count. |
| docs/app/pyproject.toml | Raises the minimum reflex-enterprise version to the release containing the documented audit hook. |
| uv.lock | Locks reflex-enterprise 0.9.3 consistently with the docs application manifest. |
Reviews (2): Last reviewed commit: "Merge remote-tracking branch 'origin/cla..." | Re-trigger Greptile
Merging this PR will not alter performance
Comparing 
Footnotes
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 2e4ade4a58
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Documents AuthPlugin(audit=...) — the observe-only audit hook shipping in reflex-enterprise 0.9.3 (reflex-dev/reflex-enterprise#200): configuration, action/outcome taxonomy, the AuditContext reference, and the fail-open, volume, privacy, and popup-flow semantics. Registers the page in the enterprise sidebar and the overview's Authentication block.
reflex-enterprise 0.9.3 (the release shipping AuthPlugin(audit=...)) is out, so the docs app can now depend on it: - docs/app: bump the reflex-enterprise floor 0.9.1 -> 0.9.3, update uv.lock to the published 0.9.3 artifacts. Review feedback on the audit page (reflex-dev#6818): - Stop implying an audit event can be handed directly to a JSON/SIEM encoder: AuditContext carries live State/AuthUserState/EventHandler objects and an arbitrary payload, so a standard JSON encoder raises TypeError. Recommend projecting to the plain fields the sink needs. - Document that context.route has query/fragment stripped (the query can carry OAuth codes or invite tokens), matching _redact_route. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HV6yayZcAfarxTDwSZY2oL
…r-bvzo8d' into farhan/eng-10376-audit-hook-docs
masenf
left a comment
masenf
left a comment
There was a problem hiding this comment.
is this still draft? it looks mergable to me, now that i brought in the actual audit functionality and shipped 0.9.3
|
It is ready to merge just wanted to test behavior after ai review fixes. |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
No issues found across 5 files
Tip: cubic could auto-approve low-risk PRs like this, if it thinks it's safe to merge. Learn more
Re-trigger cubic
3 participants
Summary
Documents the new
AuthPlugin(audit=...)observe-only audit hook (implemented in reflex-dev/reflex-enterprise#200, shipping in reflex-enterprise 0.9.3):docs/enterprise/auth/audit.md— configuration (callable / import-path string, eager validation), the action/outcome taxonomy tables, theAuditContextfield reference, and the semantics users need to know: observe-only + fail-open, awaited inline (keep hooks fast), what is and isn't audited,event_handler/allowedvolume, redaction responsibility, popup-flow event pairing, and writing events into app state viacontext.state.docs/enterprise/overview.md's Authentication block (count 6 → 7).Notes
reflex_enterprise.auth.auditmodule docstring and was validated against the implementation (all snippets exercised by the unit/integration tests in the enterprise PR).Testing
enterprise.auth.audit.pathand the sidebar entry verified to resolve viareflex_docsimport (docgen auto-generates the page from the md tree;/enterprise/authwhitelist prefix covers the route).